Documentation for Radius + Flux integration by willdavsmith · Pull Request #1408 · radius-project/docs

willdavsmith · 2025-03-24T22:17:25Z

Thank you for helping make the Radius documentation better!

Please follow this checklist before submitting:

Read the contribution guide
Commands include options for Linux, MacOS, and Windows within codetabs
New file and folder names are globally unique
Page references use shortcodes instead of markdown or URL links
Images use HTML style and have alternative text
Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Issue reference

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

willdavsmith · 2025-03-24T22:18:58Z

 1. This is the second step, and will be displayed with a 2 in the docs.
 1. This is the third step, and will be displayed with a 3.
-1. This is the first step of a process.
 ```


typo that I came across

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

brooke-hamilton

Nice docs. 📜 Small suggestions.

brooke-hamilton · 2025-03-28T19:05:16Z

+
+This guide provides an overview of how to integrate Radius with [Flux](https://fluxcd.io/), a popular GitOps tool. It covers the installation and configuration of Flux, as well as how to deploy your Radius applications using Flux. For a guided tutorial, check out the  [Radius + Flux Tutorial]({{< ref "tutorials/gitops-flux" >}}).
+
+## Overview


This section contains the Radius configuration instead of an overview. How about renaming this section to "Radius Setup" or "Radius Configuration" and have a brief "Overview" section of one or two sentences that describes how Radius needs configuration files added and Flux needs to be configured to connect to the repo where Radius config files are stored?

Can we just fold this all into one Flux How-To guide under a parent GitOps section?

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

willtsai

Overall, great comprehensive content! I have some in line suggestions and also request that you organize the content into a set of how-to guides, similar to how the Dapr guides are organized: docs/content/guides/author-apps/dapr

willtsai · 2025-03-28T21:02:44Z

let's remove this for now, we usually don't add "coming soon" style content like this to our tech documentation

willtsai · 2025-03-28T21:04:37Z

+tags: ["flux", "gitops", "continuous", "delivery", "deployment"]
+---
+
+This guide provides an overview of how to integrate Radius with [Flux](https://fluxcd.io/), a popular GitOps tool. It covers the installation and configuration of Flux, as well as how to deploy your Radius applications using Flux. For a guided tutorial, check out the  [Radius + Flux Tutorial]({{< ref "tutorials/gitops-flux" >}}).


Suggested change

This guide provides an overview of how to integrate Radius with [Flux](https://fluxcd.io/), a popular GitOps tool. It covers the installation and configuration of Flux, as well as how to deploy your Radius applications using Flux. For a guided tutorial, check out the [Radius + Flux Tutorial]({{< ref "tutorials/gitops-flux" >}}).

This guide provides an overview of how to integrate Radius with [Flux](https://fluxcd.io/), an open-source GitOps tool that's also part of the CNCF. It covers the installation and configuration of Flux, as well as how to deploy your Radius applications using Flux. For a guided tutorial, check out the [Radius + Flux Tutorial]({{< ref "tutorials/gitops-flux" >}}).

willtsai · 2025-03-28T21:05:10Z

+
+This guide provides an overview of how to integrate Radius with [Flux](https://fluxcd.io/), a popular GitOps tool. It covers the installation and configuration of Flux, as well as how to deploy your Radius applications using Flux. For a guided tutorial, check out the  [Radius + Flux Tutorial]({{< ref "tutorials/gitops-flux" >}}).
+
+## Overview


willtsai · 2025-03-28T21:20:43Z

+### Install the Flux CLI
+
+1. Follow the [Flux CLI installation instructions](https://fluxcd.io/docs/installation/#install-the-flux-cli) to install the Flux CLI on your local machine.
+
+1. Verify the installation by running:
+
+   ```bash
+   flux version
+   ```
+
+### Install the Flux Source Controller
+
+The only required component for this integration is the Flux source controller. This component is responsible for managing the Git repository and syncing it with your Kubernetes cluster.
+
+1. Install Flux in your Kubernetes cluster:
+
+   ```bash
+   flux install --namespace=flux-system --version=latest --components=source-controller --network-policy=false
+   ```
+
+   {{< alert title="⚠️ Network Policy" color="warning" >}}
+   The `--network-policy=false` flag is specified here to disable the network policy for the Flux source controller, since by default access to Flux components is restricted. For a production setup, you can instead remove this flag and configure the network policy to allow `radius-system` namespace access to the source controller. This will ensure that the source controller can communicate with your Git repository and sync changes effectively.
+   For more information on the network policy, see the [Flux documentation](https://fluxcd.io/flux/installation/configuration/optional-components/#network-policies).
+   {{< /alert >}}


This looks like it's all Flux-specific instructions, can we remove this and just link a pointer to the Flux documentation for these steps? kind of like how we just call out that the user needs to have dapr installed in their cluster and point them to the dapr docs: https://docs.radapp.io/tutorials/dapr/#prerequisites

fixed, I kept the alert though because the user most likely will not have this flag enabled so I think it'd be good to call it out. In the future we could write a "flux setup" docs page with the right network policy.

willtsai · 2025-03-28T21:22:08Z

+### Configure Flux
+
+Now that you have installed the Flux CLI and the source controller, you can use Flux as you do today to manage your Git repository, such as by using the [`flux create source git`](https://fluxcd.io/flux/cmd/flux_create_source_git/) CLI command to associate your Git repository with the Flux source controller.


same thing here, just point to Flux, or perhaps even add this step to the troubleshooting section, e.g. If your changes in the repo aren't being detected by Flux, make sure you have configured it properly per the instructions here.

willtsai · 2025-03-28T21:46:04Z

+## Step 3: Initialize a Radius Environment and Application
+
+1. Initialize a new Radius Environment with [`rad init`]({{< ref rad_initialize >}}):
+
+   ```bash
+   rad init
+   ```
+
+   When asked if you want to create a new application select "Yes". This will create a new file named `app.bicep` in your directory where your application will be defined. It will also create a [`bicepconfig.json`]({{< ref "/guides/tooling/bicepconfig/overview" >}}) file that will contain the necessary setup to use Radius types with Bicep.


remove this and just add it as an additional item in prereqs:

[Radius environment]({{< ref "installation#step-3-initialize-radius" >}})

[Radius local-dev Recipes]({{< ref howto-dev-recipes >}})

willtsai · 2025-03-28T21:48:13Z

+## Step 3: Prepare Application for Deployment by Flux
+
+1. Open `app.bicep` and see the scaffolded application created by `rad init`:
+
+   {{% rad file="snippets/1-app.bicep" embed=true %}}
+
+1. Update the `app.bicep` file. We want to link the default environment and specify an application to deploy Radius resources to.
+
+   {{% rad file="snippets/2-app-with-environment.bicep" embed=true %}}
+
+   This Radius application is now ready to be deployed. Instead of using the `rad deploy` CLI command, we will use Flux to detect changes in the Git repository and deploy the application automatically.


Make this its own step, and instead of asking the user to use the scaffolded default app, have them just create a new app.bicep with the bicep snippet available for them to follow. See example here: https://docs.radapp.io/guides/author-apps/dapr/how-to-dapr-sidecar/

willtsai · 2025-03-28T21:49:42Z

+   git push origin main
+   ```
+
+## Step 4: Configure Flux to Manage Your Application


these Flux specific steps are fine to include as they are core to the Flux+Radius workflow

willtsai · 2025-03-28T21:51:55Z

+   ```
+
+   Congratulations! You have successfully integrated Radius with Flux for GitOps. You can now manage your Radius applications using Git as the single source of truth.
+


add a clean up step for the user to clean up the Radius stuff they created for this how-to, see https://docs.radapp.io/guides/author-apps/dapr/how-to-dapr-sidecar/#cleanup

willtsai · 2025-03-28T21:52:23Z

+
+## Next steps
+
+Check out the [Radius + GitOps overview]({{< ref "guides/deploy-apps/gitops/overview" >}}) for more detailed information on how to use Radius with GitOps.


Suggested change

Check out the [Radius + GitOps overview]({{< ref "guides/deploy-apps/gitops/overview" >}}) for more detailed information on how to use Radius with GitOps.

Check out the [Radius + GitOps overview]({{< ref "guides/deploy-apps/gitops/overview" >}}) for more information on how to use Radius integrates with GitOps solutions.

brooke-hamilton

🥇

brooke-hamilton · 2025-03-28T21:54:49Z

+To enable this integration, you need to create a `radius-config.yaml` file in your Git repository. This file specifies the Bicep files to deploy and their parameters.
+
+Here is an example showing all of the options for the `radius-config.yaml` file:


Suggested change

To enable this integration, you need to create a `radius-config.yaml` file in your Git repository. This file specifies the Bicep files to deploy and their parameters.

Here is an example showing all of the options for the `radius-config.yaml` file:

To enable this integration, you need to create a `radius-gitops-config.yaml` file in your Git repository. This file specifies the Bicep files to deploy and their parameters.

Here is an example showing all of the options for the `radius-gitops-config.yaml` file:

# Description * Add Radius Flux controller and tests * Update test workflows to install and use Flux and Gitea * Add bicep container and changes to allow for Bicep to run server-side in `controller` pod Note: I expect the functional tests to fail for this PR because I'm updating the functional test workflow. Here's a link to a successful action run: https://github.com/radius-project/radius/actions/runs/14074009492 Design PR: radius-project/design-notes#79 Docs PR: radius-project/docs#1408 ## Type of change  - This pull request fixes a bug in Radius and has an approved issue (issue link required). - This pull request adds or changes features of Radius and has an approved issue (issue link required). - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).  Fixes: #6689 ## Contributor checklist Please verify that the PR meets the following requirements, where applicable: - An overview of proposed schema changes is included in a linked GitHub issue. - [ ] Yes - [x] Not applicable - A design document PR is created in the [design-notes repository](https://github.com/radius-project/design-notes/), if new APIs are being introduced. - [x] Yes - [ ] Not applicable - The design document has been reviewed and approved by Radius maintainers/approvers. - [x] Yes - [ ] Not applicable - A PR for the [samples repository](https://github.com/radius-project/samples) is created, if existing samples are affected by the changes in this PR. - [ ] Yes - [x] Not applicable - A PR for the [documentation repository](https://github.com/radius-project/docs) is created, if the changes in this PR affect the documentation or any user facing updates are made. - [x] Yes - [ ] Not applicable - A PR for the [recipes repository](https://github.com/radius-project/recipes) is created, if existing recipes are affected by the changes in this PR. - [ ] Yes - [x] Not applicable --------- Signed-off-by: willdavsmith <willdavsmith@gmail.com>

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

brooke-hamilton

willtsai

Thanks for the edits, looking good so far! My last piece of feedback is to bring this GitOps Overview page back (it was in your previous commit) - 06ba960#diff-b714710b9e0d5608c922f58f9232cf560c965f9a825398bc7032c755a45289de

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

willtsai

LGTM

# Description * Add Radius Flux controller and tests * Update test workflows to install and use Flux and Gitea * Add bicep container and changes to allow for Bicep to run server-side in `controller` pod Note: I expect the functional tests to fail for this PR because I'm updating the functional test workflow. Here's a link to a successful action run: https://github.com/radius-project/radius/actions/runs/14074009492 Design PR: radius-project/design-notes#79 Docs PR: radius-project/docs#1408 ## Type of change  - This pull request fixes a bug in Radius and has an approved issue (issue link required). - This pull request adds or changes features of Radius and has an approved issue (issue link required). - This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).  Fixes: #6689 ## Contributor checklist Please verify that the PR meets the following requirements, where applicable: - An overview of proposed schema changes is included in a linked GitHub issue. - [ ] Yes - [x] Not applicable - A design document PR is created in the [design-notes repository](https://github.com/radius-project/design-notes/), if new APIs are being introduced. - [x] Yes - [ ] Not applicable - The design document has been reviewed and approved by Radius maintainers/approvers. - [x] Yes - [ ] Not applicable - A PR for the [samples repository](https://github.com/radius-project/samples) is created, if existing samples are affected by the changes in this PR. - [ ] Yes - [x] Not applicable - A PR for the [documentation repository](https://github.com/radius-project/docs) is created, if the changes in this PR affect the documentation or any user facing updates are made. - [x] Yes - [ ] Not applicable - A PR for the [recipes repository](https://github.com/radius-project/recipes) is created, if existing recipes are affected by the changes in this PR. - [ ] Yes - [x] Not applicable --------- Signed-off-by: willdavsmith <willdavsmith@gmail.com>

* Docs for GitOps + Flux Signed-off-by: willdavsmith <willdavsmith@gmail.com> * spellcheck Signed-off-by: willdavsmith <willdavsmith@gmail.com> * spelling Signed-off-by: willdavsmith <willdavsmith@gmail.com> * PR Signed-off-by: willdavsmith <willdavsmith@gmail.com> * PR Signed-off-by: willdavsmith <willdavsmith@gmail.com> * PR Signed-off-by: willdavsmith <willdavsmith@gmail.com> --------- Signed-off-by: willdavsmith <willdavsmith@gmail.com> Signed-off-by: Vishwanath Hiremath <vhiremath@microsoft.com>

Docs for GitOps + Flux

06ba960

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

willdavsmith requested review from a team as code owners March 24, 2025 22:17

willdavsmith temporarily deployed to edge March 24, 2025 22:18 — with GitHub Actions Inactive

willdavsmith commented Mar 24, 2025

View reviewed changes

willdavsmith temporarily deployed to edge March 24, 2025 22:28 — with GitHub Actions Inactive

willdavsmith mentioned this pull request Mar 27, 2025

Add Radius Flux Controller for GitOps support radius-project/radius#8784

Merged

6 of 12 tasks

spellcheck

4796a85

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

willdavsmith temporarily deployed to edge March 27, 2025 16:48 — with GitHub Actions Inactive

willdavsmith temporarily deployed to edge March 27, 2025 16:49 — with GitHub Actions Inactive

spelling

8f8d6bf

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

willdavsmith temporarily deployed to edge March 28, 2025 17:28 — with GitHub Actions Inactive

willdavsmith temporarily deployed to edge March 28, 2025 17:32 — with GitHub Actions Inactive

brooke-hamilton requested changes Mar 28, 2025

View reviewed changes

PR

9be87b4

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

willdavsmith requested a review from brooke-hamilton March 28, 2025 20:32

willdavsmith temporarily deployed to edge March 28, 2025 20:32 — with GitHub Actions Inactive

willtsai reviewed Mar 28, 2025

View reviewed changes

brooke-hamilton requested changes Mar 28, 2025

View reviewed changes

PR

2534a67

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

willdavsmith requested review from brooke-hamilton and willtsai March 31, 2025 21:32

willdavsmith temporarily deployed to edge March 31, 2025 21:33 — with GitHub Actions Inactive

willdavsmith temporarily deployed to edge March 31, 2025 21:36 — with GitHub Actions Inactive

brooke-hamilton approved these changes Mar 31, 2025

View reviewed changes

willtsai reviewed Apr 1, 2025

View reviewed changes

PR

172cc92

Signed-off-by: willdavsmith <willdavsmith@gmail.com>

willdavsmith temporarily deployed to edge April 1, 2025 17:36 — with GitHub Actions Inactive

willdavsmith temporarily deployed to edge April 1, 2025 17:37 — with GitHub Actions Inactive

willtsai approved these changes Apr 1, 2025

View reviewed changes

willdavsmith merged commit cd06c0c into radius-project:edge Apr 1, 2025

willdavsmith temporarily deployed to edge April 1, 2025 19:19 — with GitHub Actions Inactive

willtsai mentioned this pull request Apr 1, 2025

Add GitOps and Flux documentation #1397

Closed

6 tasks done


		This guide provides an overview of how to integrate Radius with [Flux](https://fluxcd.io/), a popular GitOps tool. It covers the installation and configuration of Flux, as well as how to deploy your Radius applications using Flux. For a guided tutorial, check out the [Radius + Flux Tutorial]({{< ref "tutorials/gitops-flux" >}}).

		## Overview

		### Configure Flux

		Now that you have installed the Flux CLI and the source controller, you can use Flux as you do today to manage your Git repository, such as by using the [`flux create source git`](https://fluxcd.io/flux/cmd/flux_create_source_git/) CLI command to associate your Git repository with the Flux source controller.

		```

		Congratulations! You have successfully integrated Radius with Flux for GitOps. You can now manage your Radius applications using Git as the single source of truth.


		## Next steps

		Check out the [Radius + GitOps overview]({{< ref "guides/deploy-apps/gitops/overview" >}}) for more detailed information on how to use Radius with GitOps.

		To enable this integration, you need to create a `radius-config.yaml` file in your Git repository. This file specifies the Bicep files to deploy and their parameters.

		Here is an example showing all of the options for the `radius-config.yaml` file:

Conversation

willdavsmith commented Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue reference

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brooke-hamilton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

willtsai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brooke-hamilton left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

brooke-hamilton left a comment

Choose a reason for hiding this comment

Uh oh!

willtsai left a comment

Choose a reason for hiding this comment

Uh oh!

willtsai left a comment

Choose a reason for hiding this comment

Uh oh!

This branch was previously deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

willdavsmith commented Mar 24, 2025 •

edited

Loading